204 строки
17 KiB
YAML
204 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters"
|
|
name: "SubscriptionCreateParameters"
|
|
nameWithType: "SubscriptionCreateParameters"
|
|
summary: "Subscription create details."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **SubscriptionCreateParameters**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.SubscriptionCreateParameters()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.SubscriptionCreateParameters()"
|
|
name: "SubscriptionCreateParameters()"
|
|
nameWithType: "SubscriptionCreateParameters.SubscriptionCreateParameters()"
|
|
syntax: "public SubscriptionCreateParameters()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.allowTracing()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.allowTracing()"
|
|
name: "allowTracing()"
|
|
nameWithType: "SubscriptionCreateParameters.allowTracing()"
|
|
summary: "Get determines whether tracing can be enabled."
|
|
syntax: "public Boolean allowTracing()"
|
|
desc: "Get determines whether tracing can be enabled."
|
|
returns:
|
|
description: "the allowTracing value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.displayName()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.displayName()"
|
|
name: "displayName()"
|
|
nameWithType: "SubscriptionCreateParameters.displayName()"
|
|
summary: "Get subscription name."
|
|
syntax: "public String displayName()"
|
|
desc: "Get subscription name."
|
|
returns:
|
|
description: "the displayName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.ownerId()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.ownerId()"
|
|
name: "ownerId()"
|
|
nameWithType: "SubscriptionCreateParameters.ownerId()"
|
|
summary: "Get user (user id path) for whom subscription is being created in form /users/\\{user<wbr>Id\\}."
|
|
syntax: "public String ownerId()"
|
|
desc: "Get user (user id path) for whom subscription is being created in form /users/\\{userId\\}."
|
|
returns:
|
|
description: "the ownerId value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.primaryKey()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.primaryKey()"
|
|
name: "primaryKey()"
|
|
nameWithType: "SubscriptionCreateParameters.primaryKey()"
|
|
summary: "Get primary subscription key."
|
|
syntax: "public String primaryKey()"
|
|
desc: "Get primary subscription key. If not specified during request key will be generated automatically."
|
|
returns:
|
|
description: "the primaryKey value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.scope()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.scope()"
|
|
name: "scope()"
|
|
nameWithType: "SubscriptionCreateParameters.scope()"
|
|
summary: "Get scope like /products/\\{product<wbr>Id\\} or /apis or /apis/\\{api<wbr>Id\\}."
|
|
syntax: "public String scope()"
|
|
desc: "Get scope like /products/\\{productId\\} or /apis or /apis/\\{apiId\\}."
|
|
returns:
|
|
description: "the scope value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.secondaryKey()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.secondaryKey()"
|
|
name: "secondaryKey()"
|
|
nameWithType: "SubscriptionCreateParameters.secondaryKey()"
|
|
summary: "Get secondary subscription key."
|
|
syntax: "public String secondaryKey()"
|
|
desc: "Get secondary subscription key. If not specified during request key will be generated automatically."
|
|
returns:
|
|
description: "the secondaryKey value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.state()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.state()"
|
|
name: "state()"
|
|
nameWithType: "SubscriptionCreateParameters.state()"
|
|
summary: "Get initial subscription state."
|
|
syntax: "public SubscriptionState state()"
|
|
desc: "Get initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are \\* active \\\\u2013 the subscription is active, \\* suspended \\\\u2013 the subscription is blocked, and the subscriber cannot call any APIs of the product, \\* submitted \\\\u2013 the subscription request has been made by the developer, but has not yet been approved or rejected, \\* rejected \\\\u2013 the subscription request has been denied by an administrator, \\* cancelled \\\\u2013 the subscription has been cancelled by the developer or administrator, \\* expired \\\\u2013 the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'."
|
|
returns:
|
|
description: "the state value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionState?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionState&text=SubscriptionState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withAllowTracing(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withAllowTracing(Boolean allowTracing)"
|
|
name: "withAllowTracing(Boolean allowTracing)"
|
|
nameWithType: "SubscriptionCreateParameters.withAllowTracing(Boolean allowTracing)"
|
|
summary: "Set determines whether tracing can be enabled."
|
|
parameters:
|
|
- description: "the allowTracing value to set"
|
|
name: "allowTracing"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withAllowTracing(Boolean allowTracing)"
|
|
desc: "Set determines whether tracing can be enabled."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withDisplayName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withDisplayName(String displayName)"
|
|
name: "withDisplayName(String displayName)"
|
|
nameWithType: "SubscriptionCreateParameters.withDisplayName(String displayName)"
|
|
summary: "Set subscription name."
|
|
parameters:
|
|
- description: "the displayName value to set"
|
|
name: "displayName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withDisplayName(String displayName)"
|
|
desc: "Set subscription name."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withOwnerId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withOwnerId(String ownerId)"
|
|
name: "withOwnerId(String ownerId)"
|
|
nameWithType: "SubscriptionCreateParameters.withOwnerId(String ownerId)"
|
|
summary: "Set user (user id path) for whom subscription is being created in form /users/\\{user<wbr>Id\\}."
|
|
parameters:
|
|
- description: "the ownerId value to set"
|
|
name: "ownerId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withOwnerId(String ownerId)"
|
|
desc: "Set user (user id path) for whom subscription is being created in form /users/\\{userId\\}."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withPrimaryKey(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withPrimaryKey(String primaryKey)"
|
|
name: "withPrimaryKey(String primaryKey)"
|
|
nameWithType: "SubscriptionCreateParameters.withPrimaryKey(String primaryKey)"
|
|
summary: "Set primary subscription key."
|
|
parameters:
|
|
- description: "the primaryKey value to set"
|
|
name: "primaryKey"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withPrimaryKey(String primaryKey)"
|
|
desc: "Set primary subscription key. If not specified during request key will be generated automatically."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withScope(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withScope(String scope)"
|
|
name: "withScope(String scope)"
|
|
nameWithType: "SubscriptionCreateParameters.withScope(String scope)"
|
|
summary: "Set scope like /products/\\{product<wbr>Id\\} or /apis or /apis/\\{api<wbr>Id\\}."
|
|
parameters:
|
|
- description: "the scope value to set"
|
|
name: "scope"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withScope(String scope)"
|
|
desc: "Set scope like /products/\\{productId\\} or /apis or /apis/\\{apiId\\}."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withSecondaryKey(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withSecondaryKey(String secondaryKey)"
|
|
name: "withSecondaryKey(String secondaryKey)"
|
|
nameWithType: "SubscriptionCreateParameters.withSecondaryKey(String secondaryKey)"
|
|
summary: "Set secondary subscription key."
|
|
parameters:
|
|
- description: "the secondaryKey value to set"
|
|
name: "secondaryKey"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withSecondaryKey(String secondaryKey)"
|
|
desc: "Set secondary subscription key. If not specified during request key will be generated automatically."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withState(com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionState)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters.withState(SubscriptionState state)"
|
|
name: "withState(SubscriptionState state)"
|
|
nameWithType: "SubscriptionCreateParameters.withState(SubscriptionState state)"
|
|
summary: "Set initial subscription state."
|
|
parameters:
|
|
- description: "the state value to set"
|
|
name: "state"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionState?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionState&text=SubscriptionState\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SubscriptionCreateParameters withState(SubscriptionState state)"
|
|
desc: "Set initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are \\* active \\\\u2013 the subscription is active, \\* suspended \\\\u2013 the subscription is blocked, and the subscriber cannot call any APIs of the product, \\* submitted \\\\u2013 the subscription request has been made by the developer, but has not yet been approved or rejected, \\* rejected \\\\u2013 the subscription request has been denied by an administrator, \\* cancelled \\\\u2013 the subscription has been cancelled by the developer or administrator, \\* expired \\\\u2013 the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'."
|
|
returns:
|
|
description: "the SubscriptionCreateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionCreateParameters&text=SubscriptionCreateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Subscription create details."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
|
|
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
|