通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Subscription - Get

  • 参考
服务:
API Management
API 版本:
2024-05-01

获取指定的订阅实体。

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

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API 管理服务的名称。
sid
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

订阅实体标识符。 该实体表示用户与 API 管理中的产品之间的关联。
subscriptionId
 path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。

响应

名称 类型 说明
200 OK

SubscriptionContract

响应正文包含指定的订阅实体。

标头

ETag: string
Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetSubscription

示例请求

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

示例响应

状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "5931a769d8d14f0ad8ce13b8",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "Unlimited",
    "state": "submitted",
    "createdDate": "2017-06-02T17:59:06.223Z"
  }
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
SubscriptionContract

订阅详细信息。
SubscriptionState

订阅状态。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

SubscriptionContract

Object

订阅详细信息。

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

资源的名称
properties.allowTracing

boolean

确定是否启用跟踪
properties.createdDate

string (date-time)

订阅创建日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
properties.displayName

string

minLength: 0
maxLength: 100

订阅的名称，如果订阅没有名称，则为 null。
properties.endDate

string (date-time)

订阅已取消或过期的日期。 此设置仅用于审核目的，订阅不会自动取消。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
properties.expirationDate

string (date-time)

订阅到期日期。 此设置仅用于审核目的，订阅不会自动过期。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
properties.notificationDate

string (date-time)

即将推出的订阅过期通知日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
properties.ownerId

string

订阅所有者的用户资源标识符。 该值是 /users/{userId} 格式的有效相对 URL，其中 {userId} 是用户标识符。
properties.primaryKey

string

minLength: 1
maxLength: 256

订阅主密钥。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。
properties.scope

string

范围，如 /products/{productId} 或 /apis 或 /apis/{apiId}。
properties.secondaryKey

string

minLength: 1
maxLength: 256

订阅辅助密钥。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。
properties.startDate

string (date-time)

订阅激活日期。 此设置仅用于审核目的，订阅不会自动激活。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
properties.state

SubscriptionState

订阅状态。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。
properties.stateComment

string

当状态更改为“已拒绝”时，管理员添加的可选订阅注释。
type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SubscriptionState

枚举

订阅状态。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。

值 说明
active
cancelled
expired
rejected
submitted
suspended