ApiManagementServiceResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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>
public class ApiManagementServiceResource : Azure.ResourceManager.ArmResource
type ApiManagementServiceResource = class
inherit ArmResource
interface IJsonModel<ApiManagementServiceData>
interface IPersistableModel<ApiManagementServiceData>
type ApiManagementServiceResource = class
inherit ArmResource
Public Class ApiManagementServiceResource
Inherits ArmResource
Implements IJsonModel(Of ApiManagementServiceData), IPersistableModel(Of ApiManagementServiceData)
Public Class ApiManagementServiceResource
Inherits ArmResource
- Inheritance
- Implements
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.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
ApplyNetworkConfigurationUpdates(WaitUntil, ApiManagementServiceApplyNetworkConfigurationContent, CancellationToken) |
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
|
ApplyNetworkConfigurationUpdatesAsync(WaitUntil, ApiManagementServiceApplyNetworkConfigurationContent, CancellationToken) |
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
|
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.
|
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.
|
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.
|
CreateOrUpdateContentItemAsync(String, String, Nullable<ETag>, CancellationToken) |
Creates a new developer portal's content item specified by the provided content type.
|
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
|
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
|
CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a ApiManagementServiceResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes an existing API Management service.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes an existing API Management service.
|
DeleteContentItem(String, String, ETag, CancellationToken) |
Removes the specified developer portal's content item.
|
DeleteContentItemAsync(String, String, ETag, CancellationToken) |
Removes the specified developer portal's content item.
|
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
|
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
|
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.
|
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.
|
Get(CancellationToken) |
Gets an API Management service resource description.
|
GetApi(String, CancellationToken) |
Gets the details of the API specified by its identifier.
|
GetApiAsync(String, CancellationToken) |
Gets the details of the API specified by its identifier.
|
GetApiManagementAuthorizationServer(String, CancellationToken) |
Gets the details of the authorization server specified by its identifier.
|
GetApiManagementAuthorizationServerAsync(String, CancellationToken) |
Gets the details of the authorization server specified by its identifier.
|
GetApiManagementAuthorizationServers() |
Gets a collection of ApiManagementAuthorizationServerResources in the ApiManagementService. |
GetApiManagementBackend(String, CancellationToken) |
Gets the details of the backend specified by its identifier.
|
GetApiManagementBackendAsync(String, CancellationToken) |
Gets the details of the backend specified by its identifier.
|
GetApiManagementBackends() |
Gets a collection of ApiManagementBackendResources in the ApiManagementService. |
GetApiManagementCache(String, CancellationToken) |
Gets the details of the Cache specified by its identifier.
|
GetApiManagementCacheAsync(String, CancellationToken) |
Gets the details of the Cache specified by its identifier.
|
GetApiManagementCaches() |
Gets a collection of ApiManagementCacheResources in the ApiManagementService. |
GetApiManagementCertificate(String, CancellationToken) |
Gets the details of the certificate specified by its identifier.
|
GetApiManagementCertificateAsync(String, CancellationToken) |
Gets the details of the certificate specified by its identifier.
|
GetApiManagementCertificates() |
Gets a collection of ApiManagementCertificateResources in the ApiManagementService. |
GetApiManagementDiagnostic(String, CancellationToken) |
Gets the details of the Diagnostic specified by its identifier.
|
GetApiManagementDiagnosticAsync(String, CancellationToken) |
Gets the details of the Diagnostic specified by its identifier.
|
GetApiManagementDiagnostics() |
Gets a collection of ApiManagementDiagnosticResources in the ApiManagementService. |
GetApiManagementEmailTemplate(TemplateName, CancellationToken) |
Gets the details of the email template specified by its identifier.
|
GetApiManagementEmailTemplateAsync(TemplateName, CancellationToken) |
Gets the details of the email template specified by its identifier.
|
GetApiManagementEmailTemplates() |
Gets a collection of ApiManagementEmailTemplateResources in the ApiManagementService. |
GetApiManagementGateway(String, CancellationToken) |
Gets the details of the Gateway specified by its identifier.
|
GetApiManagementGatewayAsync(String, CancellationToken) |
Gets the details of the Gateway specified by its identifier.
|
GetApiManagementGateways() |
Gets a collection of ApiManagementGatewayResources in the ApiManagementService. |
GetApiManagementGlobalSchema(String, CancellationToken) |
Gets the details of the Schema specified by its identifier.
|
GetApiManagementGlobalSchemaAsync(String, CancellationToken) |
Gets the details of the Schema specified by its identifier.
|
GetApiManagementGlobalSchemas() |
Gets a collection of ApiManagementGlobalSchemaResources in the ApiManagementService. |
GetApiManagementGroup(String, CancellationToken) |
Gets the details of the group specified by its identifier.
|
GetApiManagementGroupAsync(String, CancellationToken) |
Gets the details of the group specified by its identifier.
|
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.
|
GetApiManagementIdentityProviderAsync(IdentityProviderType, CancellationToken) |
Gets the configuration details of the identity Provider configured in specified service instance.
|
GetApiManagementIdentityProviders() |
Gets a collection of ApiManagementIdentityProviderResources in the ApiManagementService. |
GetApiManagementIssue(String, CancellationToken) |
Gets API Management issue details
|
GetApiManagementIssueAsync(String, CancellationToken) |
Gets API Management issue details
|
GetApiManagementIssues() |
Gets a collection of ApiManagementIssueResources in the ApiManagementService. |
GetApiManagementLogger(String, CancellationToken) |
Gets the details of the logger specified by its identifier.
|
GetApiManagementLoggerAsync(String, CancellationToken) |
Gets the details of the logger specified by its identifier.
|
GetApiManagementLoggers() |
Gets a collection of ApiManagementLoggerResources in the ApiManagementService. |
GetApiManagementNamedValue(String, CancellationToken) |
Gets the details of the named value specified by its identifier.
|
GetApiManagementNamedValueAsync(String, CancellationToken) |
Gets the details of the named value specified by its identifier.
|
GetApiManagementNamedValues() |
Gets a collection of ApiManagementNamedValueResources in the ApiManagementService. |
GetApiManagementNotification(NotificationName, CancellationToken) |
Gets the details of the Notification specified by its identifier.
|
GetApiManagementNotificationAsync(NotificationName, CancellationToken) |
Gets the details of the Notification specified by its identifier.
|
GetApiManagementNotifications() |
Gets a collection of ApiManagementNotificationResources in the ApiManagementService. |
GetApiManagementOpenIdConnectProvider(String, CancellationToken) |
Gets specific OpenID Connect Provider without secrets.
|
GetApiManagementOpenIdConnectProviderAsync(String, CancellationToken) |
Gets specific OpenID Connect Provider without secrets.
|
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.
|
GetApiManagementPolicyAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken) |
Get the Global policy definition of the Api Management service.
|
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.
|
GetApiManagementPortalRevisionAsync(String, CancellationToken) |
Gets the developer portal's revision specified by its identifier.
|
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.
|
GetApiManagementPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets the details of the Private Endpoint Connection specified by its identifier.
|
GetApiManagementPrivateEndpointConnections() |
Gets a collection of ApiManagementPrivateEndpointConnectionResources in the ApiManagementService. |
GetApiManagementPrivateLinkResource(String, CancellationToken) |
Gets the private link resources
|
GetApiManagementPrivateLinkResourceAsync(String, CancellationToken) |
Gets the private link resources
|
GetApiManagementPrivateLinkResources() |
Gets a collection of ApiManagementPrivateLinkResources in the ApiManagementService. |
GetApiManagementProduct(String, CancellationToken) |
Gets the details of the product specified by its identifier.
|
GetApiManagementProductAsync(String, CancellationToken) |
Gets the details of the product specified by its identifier.
|
GetApiManagementProducts() |
Gets a collection of ApiManagementProductResources in the ApiManagementService. |
GetApiManagementSubscription(String, CancellationToken) |
Gets the specified Subscription entity.
|
GetApiManagementSubscriptionAsync(String, CancellationToken) |
Gets the specified Subscription entity.
|
GetApiManagementSubscriptions() |
Gets a collection of ApiManagementSubscriptionResources in the ApiManagementService. |
GetApiManagementTag(String, CancellationToken) |
Gets the details of the tag specified by its identifier.
|
GetApiManagementTagAsync(String, CancellationToken) |
Gets the details of the tag specified by its identifier.
|
GetApiManagementTags() |
Gets a collection of ApiManagementTagResources in the ApiManagementService. |
GetApiManagementTenantSetting(SettingsType, CancellationToken) |
Get tenant settings.
|
GetApiManagementTenantSettingAsync(SettingsType, CancellationToken) |
Get tenant settings.
|
GetApiManagementTenantSettings() |
Gets a collection of ApiManagementTenantSettingResources in the ApiManagementService. |
GetApiManagementUser(String, CancellationToken) |
Gets the details of the user specified by its identifier.
|
GetApiManagementUserAsync(String, CancellationToken) |
Gets the details of the user specified by its identifier.
|
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.
|
GetApisByTagsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
Lists a collection of apis associated with tags.
|
GetApiVersionSet(String, CancellationToken) |
Gets the details of the Api Version Set specified by its identifier.
|
GetApiVersionSetAsync(String, CancellationToken) |
Gets the details of the Api Version Set specified by its identifier.
|
GetApiVersionSets() |
Gets a collection of ApiVersionSetResources in the ApiManagementService. |
GetAsync(CancellationToken) |
Gets an API Management service resource description.
|
GetAuthorizationProviderContract(String, CancellationToken) |
Gets the details of the authorization provider specified by its identifier.
|
GetAuthorizationProviderContractAsync(String, CancellationToken) |
Gets the details of the authorization provider specified by its identifier.
|
GetAuthorizationProviderContracts() |
Gets a collection of AuthorizationProviderContractResources in the ApiManagementService. |
GetAvailableApiManagementServiceSkus(CancellationToken) |
Gets all available SKU for a given API Management service
|
GetAvailableApiManagementServiceSkusAsync(CancellationToken) |
Gets all available SKU for a given API Management service
|
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.
|
GetContentItemAsync(String, String, CancellationToken) |
Returns the developer portal's content item specified by its identifier.
|
GetContentItemEntityTag(String, String, CancellationToken) |
Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.
|
GetContentItemEntityTagAsync(String, String, CancellationToken) |
Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.
|
GetContentItems(String, CancellationToken) |
Lists developer portal's content items specified by the provided content type.
|
GetContentItemsAsync(String, CancellationToken) |
Lists developer portal's content items specified by the provided content type.
|
GetContentType(String, CancellationToken) |
Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.
|
GetContentTypeAsync(String, CancellationToken) |
Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.
|
GetContentTypes(CancellationToken) |
Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.
|
GetContentTypesAsync(CancellationToken) |
Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.
|
GetDocumentationContract(String, CancellationToken) |
Gets the details of the Documentation specified by its identifier.
|
GetDocumentationContractAsync(String, CancellationToken) |
Gets the details of the Documentation specified by its identifier.
|
GetDocumentationContracts() |
Gets a collection of DocumentationContractResources in the ApiManagementService. |
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
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.
|
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.
|
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.
|
GetOutboundNetworkDependenciesEndpoints(CancellationToken) |
Gets the network endpoints of all outbound dependencies of a ApiManagement service.
|
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken) |
Gets the network endpoints of all outbound dependencies of a ApiManagement service.
|
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
GetPolicyDescriptions(Nullable<PolicyScopeContract>, CancellationToken) |
Lists all policy descriptions.
|
GetPolicyDescriptionsAsync(Nullable<PolicyScopeContract>, CancellationToken) |
Lists all policy descriptions.
|
GetPolicyFragmentContract(String, Nullable<PolicyFragmentContentFormat>, CancellationToken) |
Gets a policy fragment.
|
GetPolicyFragmentContractAsync(String, Nullable<PolicyFragmentContentFormat>, CancellationToken) |
Gets a policy fragment.
|
GetPolicyFragmentContracts() |
Gets a collection of PolicyFragmentContractResources in the ApiManagementService. |
GetPortalConfigContract(String, CancellationToken) |
Get the developer portal configuration.
|
GetPortalConfigContractAsync(String, CancellationToken) |
Get the developer portal configuration.
|
GetPortalConfigContracts() |
Gets a collection of PortalConfigContractResources in the ApiManagementService. |
GetPortalSettings(CancellationToken) |
Lists a collection of portalsettings defined within a service instance..
|
GetPortalSettingsAsync(CancellationToken) |
Lists a collection of portalsettings defined within a service instance..
|
GetProductsByTags(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
Lists a collection of products associated with tags.
|
GetProductsByTagsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
Lists a collection of products associated with tags.
|
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.
|
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.
|
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.
|
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.
|
GetRegions(CancellationToken) |
Lists all azure regions in which the service exists.
|
GetRegionsAsync(CancellationToken) |
Lists all azure regions in which the service exists.
|
GetReportsByApi(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by API.
|
GetReportsByApiAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by API.
|
GetReportsByGeo(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists report records by geography.
|
GetReportsByGeoAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists report records by geography.
|
GetReportsByOperation(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by API Operations.
|
GetReportsByOperationAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by API Operations.
|
GetReportsByProduct(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by Product.
|
GetReportsByProductAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by Product.
|
GetReportsByRequest(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists report records by Request.
|
GetReportsByRequestAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists report records by Request.
|
GetReportsBySubscription(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by subscription.
|
GetReportsBySubscriptionAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by subscription.
|
GetReportsByTime(String, TimeSpan, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by Time.
|
GetReportsByTimeAsync(String, TimeSpan, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by Time.
|
GetReportsByUser(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by User.
|
GetReportsByUserAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) |
Lists report records by User.
|
GetSsoToken(CancellationToken) |
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
|
GetSsoTokenAsync(CancellationToken) |
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
|
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.
|
GetTagResourcesAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists a collection of resources associated with tags.
|
GetTenantAccessInfo(AccessName, CancellationToken) |
Get tenant access information details without secrets.
|
GetTenantAccessInfoAsync(AccessName, CancellationToken) |
Get tenant access information details without secrets.
|
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.
|
GetTenantConfigurationSyncStateAsync(ConfigurationName, CancellationToken) |
Gets the status of the most recent synchronization between the configuration database and the Git repository.
|
MigrateToStv2(WaitUntil, 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.
|
MigrateToStv2Async(WaitUntil, 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.
|
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.
|
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.
|
RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
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.
|
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.
|
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.
|
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.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
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.
|
UpdateAsync(WaitUntil, ApiManagementServicePatch, CancellationToken) |
Updates an existing API Management service.
|
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.
|
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.
|
UpdateQuotaByPeriodKey(String, String, QuotaCounterValueUpdateContent, CancellationToken) |
Updates an existing quota counter value in the specified service instance.
|
UpdateQuotaByPeriodKeyAsync(String, String, QuotaCounterValueUpdateContent, CancellationToken) |
Updates an existing quota counter value in the specified service instance.
|
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.
|
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.
|
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).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
Applies to
Azure SDK for .NET