Share via

ApiManagementServiceResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ApiManagementServiceResource.cs
Source:
ApiManagementServiceResource.cs

A Class representing an ApiManagementService along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an ApiManagementServiceResource from an instance of ArmClient using the GetApiManagementServiceResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetApiManagementService method.

public class ApiManagementServiceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiManagementServiceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiManagementServiceData>
type ApiManagementServiceResource = class
    inherit ArmResource
    interface IJsonModel<ApiManagementServiceData>
    interface IPersistableModel<ApiManagementServiceData>
Public Class ApiManagementServiceResource
Inherits ArmResource
Implements IJsonModel(Of ApiManagementServiceData), IPersistableModel(Of ApiManagementServiceData)
Inheritance
Object
ArmResource
ApiManagementServiceResource
Implements
IJsonModel<ApiManagementServiceData> IPersistableModel<ApiManagementServiceData> IPersistableModel<T>

Constructors

ApiManagementServiceResource()

Initializes a new instance of the ApiManagementServiceResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
ApplyNetworkConfigurationUpdates(WaitUntil, ApiManagementServiceApplyNetworkConfigurationContent, CancellationToken)

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates
  • Operation Id: ApiManagementService_ApplyNetworkConfigurationUpdates
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
ApplyNetworkConfigurationUpdatesAsync(WaitUntil, ApiManagementServiceApplyNetworkConfigurationContent, CancellationToken)

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates
  • Operation Id: ApiManagementService_ApplyNetworkConfigurationUpdates
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
Backup(WaitUntil, ApiManagementServiceBackupRestoreContent, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup
  • Operation Id: ApiManagementService_Backup
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
BackupAsync(WaitUntil, ApiManagementServiceBackupRestoreContent, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup
  • Operation Id: ApiManagementService_Backup
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateOrUpdateContentItem(String, String, Nullable<ETag>, CancellationToken)

Creates a new developer portal's content item specified by the provided content type.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
CreateOrUpdateContentItemAsync(String, String, Nullable<ETag>, CancellationToken)

Creates a new developer portal's content item specified by the provided content type.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
CreateOrUpdateContentType(String, Nullable<ETag>, CancellationToken)

Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
  • Operation Id: ContentType_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
CreateOrUpdateContentTypeAsync(String, Nullable<ETag>, CancellationToken)

Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the c- prefix. Built-in content types can't be modified.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
  • Operation Id: ContentType_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a ApiManagementServiceResource instance.
Delete(WaitUntil, CancellationToken)

Deletes an existing API Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Delete
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
DeleteAsync(WaitUntil, CancellationToken)

Deletes an existing API Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Delete
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
DeleteContentItem(String, String, ETag, CancellationToken)

Removes the specified developer portal's content item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_Delete
  • Default Api Version: 2023-03-01-preview
DeleteContentItemAsync(String, String, ETag, CancellationToken)

Removes the specified developer portal's content item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_Delete
  • Default Api Version: 2023-03-01-preview
DeleteContentType(String, ETag, CancellationToken)

Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can't be removed.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
  • Operation Id: ContentType_Delete
  • Default Api Version: 2023-03-01-preview
DeleteContentTypeAsync(String, ETag, CancellationToken)

Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can't be removed.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
  • Operation Id: ContentType_Delete
  • Default Api Version: 2023-03-01-preview
DeployTenantConfiguration(WaitUntil, ConfigurationName, ConfigurationDeployContent, CancellationToken)

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy
  • Operation Id: TenantConfiguration_Deploy
  • Default Api Version: 2023-03-01-preview
DeployTenantConfigurationAsync(WaitUntil, ConfigurationName, ConfigurationDeployContent, CancellationToken)

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy
  • Operation Id: TenantConfiguration_Deploy
  • Default Api Version: 2023-03-01-preview
Get(CancellationToken)

Gets an API Management service resource description.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
GetApi(String, CancellationToken)

Gets the details of the API specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • Operation Id: Api_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiResource
GetApiAsync(String, CancellationToken)

Gets the details of the API specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • Operation Id: Api_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiResource
GetApiManagementAuthorizationServer(String, CancellationToken)

Gets the details of the authorization server specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
  • Operation Id: AuthorizationServer_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementAuthorizationServerResource
GetApiManagementAuthorizationServerAsync(String, CancellationToken)

Gets the details of the authorization server specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
  • Operation Id: AuthorizationServer_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementAuthorizationServerResource
GetApiManagementAuthorizationServers()

Gets a collection of ApiManagementAuthorizationServerResources in the ApiManagementService.
GetApiManagementBackend(String, CancellationToken)

Gets the details of the backend specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}
  • Operation Id: Backend_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementBackendResource
GetApiManagementBackendAsync(String, CancellationToken)

Gets the details of the backend specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}
  • Operation Id: Backend_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementBackendResource
GetApiManagementBackends()

Gets a collection of ApiManagementBackendResources in the ApiManagementService.
GetApiManagementCache(String, CancellationToken)

Gets the details of the Cache specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
  • Operation Id: Cache_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementCacheResource
GetApiManagementCacheAsync(String, CancellationToken)

Gets the details of the Cache specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
  • Operation Id: Cache_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementCacheResource
GetApiManagementCaches()

Gets a collection of ApiManagementCacheResources in the ApiManagementService.
GetApiManagementCertificate(String, CancellationToken)

Gets the details of the certificate specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
  • Operation Id: Certificate_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementCertificateResource
GetApiManagementCertificateAsync(String, CancellationToken)

Gets the details of the certificate specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
  • Operation Id: Certificate_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementCertificateResource
GetApiManagementCertificates()

Gets a collection of ApiManagementCertificateResources in the ApiManagementService.
GetApiManagementDiagnostic(String, CancellationToken)

Gets the details of the Diagnostic specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
  • Operation Id: Diagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementDiagnosticResource
GetApiManagementDiagnosticAsync(String, CancellationToken)

Gets the details of the Diagnostic specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}
  • Operation Id: Diagnostic_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementDiagnosticResource
GetApiManagementDiagnostics()

Gets a collection of ApiManagementDiagnosticResources in the ApiManagementService.
GetApiManagementEmailTemplate(TemplateName, CancellationToken)

Gets the details of the email template specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
  • Operation Id: EmailTemplate_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementEmailTemplateResource
GetApiManagementEmailTemplateAsync(TemplateName, CancellationToken)

Gets the details of the email template specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
  • Operation Id: EmailTemplate_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementEmailTemplateResource
GetApiManagementEmailTemplates()

Gets a collection of ApiManagementEmailTemplateResources in the ApiManagementService.
GetApiManagementGateway(String, CancellationToken)

Gets the details of the Gateway specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
GetApiManagementGatewayAsync(String, CancellationToken)

Gets the details of the Gateway specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
GetApiManagementGateways()

Gets a collection of ApiManagementGatewayResources in the ApiManagementService.
GetApiManagementGlobalSchema(String, CancellationToken)

Gets the details of the Schema specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
  • Operation Id: GlobalSchema_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGlobalSchemaResource
GetApiManagementGlobalSchemaAsync(String, CancellationToken)

Gets the details of the Schema specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
  • Operation Id: GlobalSchema_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGlobalSchemaResource
GetApiManagementGlobalSchemas()

Gets a collection of ApiManagementGlobalSchemaResources in the ApiManagementService.
GetApiManagementGroup(String, CancellationToken)

Gets the details of the group specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
GetApiManagementGroupAsync(String, CancellationToken)

Gets the details of the group specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  • Operation Id: Group_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGroupResource
GetApiManagementGroups()

Gets a collection of ApiManagementGroupResources in the ApiManagementService.
GetApiManagementIdentityProvider(IdentityProviderType, CancellationToken)

Gets the configuration details of the identity Provider configured in specified service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
  • Operation Id: IdentityProvider_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementIdentityProviderResource
GetApiManagementIdentityProviderAsync(IdentityProviderType, CancellationToken)

Gets the configuration details of the identity Provider configured in specified service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
  • Operation Id: IdentityProvider_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementIdentityProviderResource
GetApiManagementIdentityProviders()

Gets a collection of ApiManagementIdentityProviderResources in the ApiManagementService.
GetApiManagementIssue(String, CancellationToken)

Gets API Management issue details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}
  • Operation Id: Issue_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementIssueResource
GetApiManagementIssueAsync(String, CancellationToken)

Gets API Management issue details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}
  • Operation Id: Issue_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementIssueResource
GetApiManagementIssues()

Gets a collection of ApiManagementIssueResources in the ApiManagementService.
GetApiManagementLogger(String, CancellationToken)

Gets the details of the logger specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}
  • Operation Id: Logger_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementLoggerResource
GetApiManagementLoggerAsync(String, CancellationToken)

Gets the details of the logger specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}
  • Operation Id: Logger_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementLoggerResource
GetApiManagementLoggers()

Gets a collection of ApiManagementLoggerResources in the ApiManagementService.
GetApiManagementNamedValue(String, CancellationToken)

Gets the details of the named value specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
  • Operation Id: NamedValue_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementNamedValueResource
GetApiManagementNamedValueAsync(String, CancellationToken)

Gets the details of the named value specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}
  • Operation Id: NamedValue_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementNamedValueResource
GetApiManagementNamedValues()

Gets a collection of ApiManagementNamedValueResources in the ApiManagementService.
GetApiManagementNotification(NotificationName, CancellationToken)

Gets the details of the Notification specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}
  • Operation Id: Notification_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementNotificationResource
GetApiManagementNotificationAsync(NotificationName, CancellationToken)

Gets the details of the Notification specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}
  • Operation Id: Notification_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementNotificationResource
GetApiManagementNotifications()

Gets a collection of ApiManagementNotificationResources in the ApiManagementService.
GetApiManagementOpenIdConnectProvider(String, CancellationToken)

Gets specific OpenID Connect Provider without secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
  • Operation Id: OpenIdConnectProvider_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementOpenIdConnectProviderResource
GetApiManagementOpenIdConnectProviderAsync(String, CancellationToken)

Gets specific OpenID Connect Provider without secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
  • Operation Id: OpenIdConnectProvider_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementOpenIdConnectProviderResource
GetApiManagementOpenIdConnectProviders()

Gets a collection of ApiManagementOpenIdConnectProviderResources in the ApiManagementService.
GetApiManagementPolicies()

Gets a collection of ApiManagementPolicyResources in the ApiManagementService.
GetApiManagementPolicy(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the Global policy definition of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
GetApiManagementPolicyAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the Global policy definition of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
GetApiManagementPortalDelegationSetting()

Gets an object representing a ApiManagementPortalDelegationSettingResource along with the instance operations that can be performed on it in the ApiManagementService.
GetApiManagementPortalRevision(String, CancellationToken)

Gets the developer portal's revision specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}
  • Operation Id: PortalRevision_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPortalRevisionResource
GetApiManagementPortalRevisionAsync(String, CancellationToken)

Gets the developer portal's revision specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}
  • Operation Id: PortalRevision_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPortalRevisionResource
GetApiManagementPortalRevisions()

Gets a collection of ApiManagementPortalRevisionResources in the ApiManagementService.
GetApiManagementPortalSignInSetting()

Gets an object representing a ApiManagementPortalSignInSettingResource along with the instance operations that can be performed on it in the ApiManagementService.
GetApiManagementPortalSignUpSetting()

Gets an object representing a ApiManagementPortalSignUpSettingResource along with the instance operations that can be performed on it in the ApiManagementService.
GetApiManagementPrivateEndpointConnection(String, CancellationToken)

Gets the details of the Private Endpoint Connection specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnection_GetByName
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPrivateEndpointConnectionResource
GetApiManagementPrivateEndpointConnectionAsync(String, CancellationToken)

Gets the details of the Private Endpoint Connection specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnection_GetByName
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPrivateEndpointConnectionResource
GetApiManagementPrivateEndpointConnections()

Gets a collection of ApiManagementPrivateEndpointConnectionResources in the ApiManagementService.
GetApiManagementPrivateLinkResource(String, CancellationToken)

Gets the private link resources

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}
  • Operation Id: PrivateEndpointConnection_GetPrivateLinkResource
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPrivateLinkResource
GetApiManagementPrivateLinkResourceAsync(String, CancellationToken)

Gets the private link resources

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}
  • Operation Id: PrivateEndpointConnection_GetPrivateLinkResource
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPrivateLinkResource
GetApiManagementPrivateLinkResources()

Gets a collection of ApiManagementPrivateLinkResources in the ApiManagementService.
GetApiManagementProduct(String, CancellationToken)

Gets the details of the product specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetApiManagementProductAsync(String, CancellationToken)

Gets the details of the product specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetApiManagementProducts()

Gets a collection of ApiManagementProductResources in the ApiManagementService.
GetApiManagementSubscription(String, CancellationToken)

Gets the specified Subscription entity.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
  • Operation Id: Subscription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementSubscriptionResource
GetApiManagementSubscriptionAsync(String, CancellationToken)

Gets the specified Subscription entity.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
  • Operation Id: Subscription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementSubscriptionResource
GetApiManagementSubscriptions()

Gets a collection of ApiManagementSubscriptionResources in the ApiManagementService.
GetApiManagementTag(String, CancellationToken)

Gets the details of the tag specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
  • Operation Id: Tag_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementTagResource
GetApiManagementTagAsync(String, CancellationToken)

Gets the details of the tag specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}
  • Operation Id: Tag_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementTagResource
GetApiManagementTags()

Gets a collection of ApiManagementTagResources in the ApiManagementService.
GetApiManagementTenantSetting(SettingsType, CancellationToken)

Get tenant settings.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}
  • Operation Id: TenantSettings_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementTenantSettingResource
GetApiManagementTenantSettingAsync(SettingsType, CancellationToken)

Get tenant settings.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}
  • Operation Id: TenantSettings_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementTenantSettingResource
GetApiManagementTenantSettings()

Gets a collection of ApiManagementTenantSettingResources in the ApiManagementService.
GetApiManagementUser(String, CancellationToken)

Gets the details of the user specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
  • Operation Id: User_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementUserResource
GetApiManagementUserAsync(String, CancellationToken)

Gets the details of the user specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
  • Operation Id: User_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementUserResource
GetApiManagementUsers()

Gets a collection of ApiManagementUserResources in the ApiManagementService.
GetApis()

Gets a collection of ApiResources in the ApiManagementService.
GetApisByTags(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Lists a collection of apis associated with tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags
  • Operation Id: Api_ListByTags
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiResource
GetApisByTagsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Lists a collection of apis associated with tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags
  • Operation Id: Api_ListByTags
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiResource
GetApiVersionSet(String, CancellationToken)

Gets the details of the Api Version Set specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
  • Operation Id: ApiVersionSet_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiVersionSetResource
GetApiVersionSetAsync(String, CancellationToken)

Gets the details of the Api Version Set specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}
  • Operation Id: ApiVersionSet_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiVersionSetResource
GetApiVersionSets()

Gets a collection of ApiVersionSetResources in the ApiManagementService.
GetAsync(CancellationToken)

Gets an API Management service resource description.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
GetAuthorizationProviderContract(String, CancellationToken)

Gets the details of the authorization provider specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}
  • Operation Id: AuthorizationProvider_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: AuthorizationProviderContractResource
GetAuthorizationProviderContractAsync(String, CancellationToken)

Gets the details of the authorization provider specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}
  • Operation Id: AuthorizationProvider_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: AuthorizationProviderContractResource
GetAuthorizationProviderContracts()

Gets a collection of AuthorizationProviderContractResources in the ApiManagementService.
GetAvailableApiManagementServiceSkus(CancellationToken)

Gets all available SKU for a given API Management service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus
  • Operation Id: ApiManagementServiceSkus_ListAvailableServiceSkus
  • Default Api Version: 2023-03-01-preview
GetAvailableApiManagementServiceSkusAsync(CancellationToken)

Gets all available SKU for a given API Management service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus
  • Operation Id: ApiManagementServiceSkus_ListAvailableServiceSkus
  • Default Api Version: 2023-03-01-preview
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetContentItem(String, String, CancellationToken)

Returns the developer portal's content item specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_Get
  • Default Api Version: 2023-03-01-preview
GetContentItemAsync(String, String, CancellationToken)

Returns the developer portal's content item specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_Get
  • Default Api Version: 2023-03-01-preview
GetContentItemEntityTag(String, String, CancellationToken)

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_GetEntityTag
  • Default Api Version: 2023-03-01-preview
GetContentItemEntityTagAsync(String, String, CancellationToken)

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}
  • Operation Id: ContentItem_GetEntityTag
  • Default Api Version: 2023-03-01-preview
GetContentItems(String, CancellationToken)

Lists developer portal's content items specified by the provided content type.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems
  • Operation Id: ContentItem_ListByService
  • Default Api Version: 2023-03-01-preview
GetContentItemsAsync(String, CancellationToken)

Lists developer portal's content items specified by the provided content type.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems
  • Operation Id: ContentItem_ListByService
  • Default Api Version: 2023-03-01-preview
GetContentType(String, CancellationToken)

Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
  • Operation Id: ContentType_Get
  • Default Api Version: 2023-03-01-preview
GetContentTypeAsync(String, CancellationToken)

Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}
  • Operation Id: ContentType_Get
  • Default Api Version: 2023-03-01-preview
GetContentTypes(CancellationToken)

Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes
  • Operation Id: ContentType_ListByService
  • Default Api Version: 2023-03-01-preview
GetContentTypesAsync(CancellationToken)

Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes
  • Operation Id: ContentType_ListByService
  • Default Api Version: 2023-03-01-preview
GetDocumentationContract(String, CancellationToken)

Gets the details of the Documentation specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetDocumentationContractAsync(String, CancellationToken)

Gets the details of the Documentation specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetDocumentationContracts()

Gets a collection of DocumentationContractResources in the ApiManagementService.
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetNetworkStatusByLocation(AzureLocation, CancellationToken)

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus
  • Operation Id: NetworkStatus_ListByLocation
  • Default Api Version: 2023-03-01-preview
GetNetworkStatusByLocationAsync(AzureLocation, CancellationToken)

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus
  • Operation Id: NetworkStatus_ListByLocation
  • Default Api Version: 2023-03-01-preview
GetNetworkStatuses(CancellationToken)

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus
  • Operation Id: NetworkStatus_ListByService
  • Default Api Version: 2023-03-01-preview
GetNetworkStatusesAsync(CancellationToken)

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus
  • Operation Id: NetworkStatus_ListByService
  • Default Api Version: 2023-03-01-preview
GetOutboundNetworkDependenciesEndpoints(CancellationToken)

Gets the network endpoints of all outbound dependencies of a ApiManagement service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints
  • Operation Id: OutboundNetworkDependenciesEndpoints_ListByService
  • Default Api Version: 2023-03-01-preview
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken)

Gets the network endpoints of all outbound dependencies of a ApiManagement service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints
  • Operation Id: OutboundNetworkDependenciesEndpoints_ListByService
  • Default Api Version: 2023-03-01-preview
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyDescriptions(Nullable<PolicyScopeContract>, CancellationToken)

Lists all policy descriptions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions
  • Operation Id: PolicyDescription_ListByService
  • Default Api Version: 2023-03-01-preview
GetPolicyDescriptionsAsync(Nullable<PolicyScopeContract>, CancellationToken)

Lists all policy descriptions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions
  • Operation Id: PolicyDescription_ListByService
  • Default Api Version: 2023-03-01-preview
GetPolicyFragmentContract(String, Nullable<PolicyFragmentContentFormat>, CancellationToken)

Gets a policy fragment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}
  • Operation Id: PolicyFragment_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: PolicyFragmentContractResource
GetPolicyFragmentContractAsync(String, Nullable<PolicyFragmentContentFormat>, CancellationToken)

Gets a policy fragment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}
  • Operation Id: PolicyFragment_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: PolicyFragmentContractResource
GetPolicyFragmentContracts()

Gets a collection of PolicyFragmentContractResources in the ApiManagementService.
GetPortalConfigContract(String, CancellationToken)

Get the developer portal configuration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
  • Operation Id: PortalConfig_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: PortalConfigContractResource
GetPortalConfigContractAsync(String, CancellationToken)

Get the developer portal configuration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
  • Operation Id: PortalConfig_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: PortalConfigContractResource
GetPortalConfigContracts()

Gets a collection of PortalConfigContractResources in the ApiManagementService.
GetPortalSettings(CancellationToken)

Lists a collection of portalsettings defined within a service instance..

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings
  • Operation Id: PortalSettings_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
GetPortalSettingsAsync(CancellationToken)

Lists a collection of portalsettings defined within a service instance..

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings
  • Operation Id: PortalSettings_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
GetProductsByTags(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Lists a collection of products associated with tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags
  • Operation Id: Product_ListByTags
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetProductsByTagsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Lists a collection of products associated with tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags
  • Operation Id: Product_ListByTags
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetQuotaByCounterKeys(String, CancellationToken)

Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
  • Operation Id: QuotaByCounterKeys_ListByService
  • Default Api Version: 2023-03-01-preview
GetQuotaByCounterKeysAsync(String, CancellationToken)

Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
  • Operation Id: QuotaByCounterKeys_ListByService
  • Default Api Version: 2023-03-01-preview
GetQuotaByPeriodKey(String, String, CancellationToken)

Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}
  • Operation Id: QuotaByPeriodKeys_Get
  • Default Api Version: 2023-03-01-preview
GetQuotaByPeriodKeyAsync(String, String, CancellationToken)

Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}
  • Operation Id: QuotaByPeriodKeys_Get
  • Default Api Version: 2023-03-01-preview
GetRegions(CancellationToken)

Lists all azure regions in which the service exists.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions
  • Operation Id: Region_ListByService
  • Default Api Version: 2023-03-01-preview
GetRegionsAsync(CancellationToken)

Lists all azure regions in which the service exists.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions
  • Operation Id: Region_ListByService
  • Default Api Version: 2023-03-01-preview
GetReportsByApi(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi
  • Operation Id: Reports_ListByApi
  • Default Api Version: 2023-03-01-preview
GetReportsByApiAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi
  • Operation Id: Reports_ListByApi
  • Default Api Version: 2023-03-01-preview
GetReportsByGeo(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists report records by geography.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo
  • Operation Id: Reports_ListByGeo
  • Default Api Version: 2023-03-01-preview
GetReportsByGeoAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists report records by geography.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo
  • Operation Id: Reports_ListByGeo
  • Default Api Version: 2023-03-01-preview
GetReportsByOperation(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by API Operations.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation
  • Operation Id: Reports_ListByOperation
  • Default Api Version: 2023-03-01-preview
GetReportsByOperationAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by API Operations.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation
  • Operation Id: Reports_ListByOperation
  • Default Api Version: 2023-03-01-preview
GetReportsByProduct(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by Product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct
  • Operation Id: Reports_ListByProduct
  • Default Api Version: 2023-03-01-preview
GetReportsByProductAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by Product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct
  • Operation Id: Reports_ListByProduct
  • Default Api Version: 2023-03-01-preview
GetReportsByRequest(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists report records by Request.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest
  • Operation Id: Reports_ListByRequest
  • Default Api Version: 2023-03-01-preview
GetReportsByRequestAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists report records by Request.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest
  • Operation Id: Reports_ListByRequest
  • Default Api Version: 2023-03-01-preview
GetReportsBySubscription(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription
  • Operation Id: Reports_ListBySubscription
  • Default Api Version: 2023-03-01-preview
GetReportsBySubscriptionAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription
  • Operation Id: Reports_ListBySubscription
  • Default Api Version: 2023-03-01-preview
GetReportsByTime(String, TimeSpan, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by Time.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime
  • Operation Id: Reports_ListByTime
  • Default Api Version: 2023-03-01-preview
GetReportsByTimeAsync(String, TimeSpan, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by Time.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime
  • Operation Id: Reports_ListByTime
  • Default Api Version: 2023-03-01-preview
GetReportsByUser(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by User.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser
  • Operation Id: Reports_ListByUser
  • Default Api Version: 2023-03-01-preview
GetReportsByUserAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Lists report records by User.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser
  • Operation Id: Reports_ListByUser
  • Default Api Version: 2023-03-01-preview
GetSsoToken(CancellationToken)

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken
  • Operation Id: ApiManagementService_GetSsoToken
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
GetSsoTokenAsync(CancellationToken)

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken
  • Operation Id: ApiManagementService_GetSsoToken
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetTagResources(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists a collection of resources associated with tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources
  • Operation Id: TagResource_ListByService
  • Default Api Version: 2023-03-01-preview
GetTagResourcesAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists a collection of resources associated with tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources
  • Operation Id: TagResource_ListByService
  • Default Api Version: 2023-03-01-preview
GetTenantAccessInfo(AccessName, CancellationToken)

Get tenant access information details without secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}
  • Operation Id: TenantAccess_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: TenantAccessInfoResource
GetTenantAccessInfoAsync(AccessName, CancellationToken)

Get tenant access information details without secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}
  • Operation Id: TenantAccess_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: TenantAccessInfoResource
GetTenantAccessInfos()

Gets a collection of TenantAccessInfoResources in the ApiManagementService.
GetTenantConfigurationSyncState(ConfigurationName, CancellationToken)

Gets the status of the most recent synchronization between the configuration database and the Git repository.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState
  • Operation Id: TenantConfiguration_GetSyncState
  • Default Api Version: 2023-03-01-preview
GetTenantConfigurationSyncStateAsync(ConfigurationName, CancellationToken)

Gets the status of the most recent synchronization between the configuration database and the Git repository.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState
  • Operation Id: TenantConfiguration_GetSyncState
  • Default Api Version: 2023-03-01-preview
GetWorkspaceContract(String, CancellationToken)

Gets the details of the workspace specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
  • Operation Id: Workspace_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: WorkspaceContractResource
GetWorkspaceContractAsync(String, CancellationToken)

Gets the details of the workspace specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
  • Operation Id: Workspace_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: WorkspaceContractResource
GetWorkspaceContracts()

Gets a collection of WorkspaceContractResources in the ApiManagementService.
MigrateToStv2(WaitUntil, MigrateToStv2Contract, CancellationToken)

Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2
  • Operation Id: ApiManagementService_MigrateToStv2
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
MigrateToStv2Async(WaitUntil, MigrateToStv2Contract, CancellationToken)

Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2
  • Operation Id: ApiManagementService_MigrateToStv2
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
PerformConnectivityCheckAsync(WaitUntil, ConnectivityCheckContent, CancellationToken)

Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck
  • Operation Id: PerformConnectivityCheckAsync
  • Default Api Version: 2023-03-01-preview
PerformConnectivityCheckAsyncAsync(WaitUntil, ConnectivityCheckContent, CancellationToken)

Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck
  • Operation Id: PerformConnectivityCheckAsync
  • Default Api Version: 2023-03-01-preview
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
Restore(WaitUntil, ApiManagementServiceBackupRestoreContent, CancellationToken)

Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore
  • Operation Id: ApiManagementService_Restore
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
RestoreAsync(WaitUntil, ApiManagementServiceBackupRestoreContent, CancellationToken)

Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore
  • Operation Id: ApiManagementService_Restore
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
SaveTenantConfiguration(WaitUntil, ConfigurationName, ConfigurationSaveContent, CancellationToken)

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save
  • Operation Id: TenantConfiguration_Save
  • Default Api Version: 2023-03-01-preview
SaveTenantConfigurationAsync(WaitUntil, ConfigurationName, ConfigurationSaveContent, CancellationToken)

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save
  • Operation Id: TenantConfiguration_Save
  • Default Api Version: 2023-03-01-preview
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, ApiManagementServicePatch, CancellationToken)

Updates an existing API Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Update
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
UpdateAsync(WaitUntil, ApiManagementServicePatch, CancellationToken)

Updates an existing API Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
  • Operation Id: ApiManagementService_Update
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementServiceResource
UpdateQuotaByCounterKeys(String, QuotaCounterValueUpdateContent, CancellationToken)

Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
  • Operation Id: QuotaByCounterKeys_Update
  • Default Api Version: 2023-03-01-preview
UpdateQuotaByCounterKeysAsync(String, QuotaCounterValueUpdateContent, CancellationToken)

Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
  • Operation Id: QuotaByCounterKeys_Update
  • Default Api Version: 2023-03-01-preview
UpdateQuotaByPeriodKey(String, String, QuotaCounterValueUpdateContent, CancellationToken)

Updates an existing quota counter value in the specified service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}
  • Operation Id: QuotaByPeriodKeys_Update
  • Default Api Version: 2023-03-01-preview
UpdateQuotaByPeriodKeyAsync(String, String, QuotaCounterValueUpdateContent, CancellationToken)

Updates an existing quota counter value in the specified service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}
  • Operation Id: QuotaByPeriodKeys_Update
  • Default Api Version: 2023-03-01-preview
ValidateTenantConfiguration(WaitUntil, ConfigurationName, ConfigurationDeployContent, CancellationToken)

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate
  • Operation Id: TenantConfiguration_Validate
  • Default Api Version: 2023-03-01-preview
ValidateTenantConfigurationAsync(WaitUntil, ConfigurationName, ConfigurationDeployContent, CancellationToken)

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate
  • Operation Id: TenantConfiguration_Validate
  • Default Api Version: 2023-03-01-preview

Explicit Interface Implementations

IJsonModel<ApiManagementServiceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ApiManagementServiceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ApiManagementServiceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ApiManagementServiceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ApiManagementServiceData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to